/*-------------------------------------------------------------------------
 *
 * 前端代码连接和断开数据库的设施。
 *
 * Portions Copyright (c) 1996-2022, PostgreSQL Global Development Group
 * Portions Copyright (c) 1994, Regents of the University of California
 *
 * src/include/fe_utils/connect_utils.h
 *
 *-------------------------------------------------------------------------
 */
#ifndef CONNECT_UTILS_H
#define CONNECT_UTILS_H

#include "libpq-fe.h"

enum trivalue
{
	TRI_DEFAULT,
	TRI_NO,
	TRI_YES
};

/* connectDatabase/connectMaintenanceDatabase所需的参数 */
typedef struct _connParams
{
	/* 这些字段记录实际的命令行参数 */
	const char *dbname;			/* 这可能是一个连接字符串！ */
	const char *pghost;
	const char *pgport;
	const char *pguser;
	enum trivalue prompt_password;
	/* 如果不是NULL，这将覆盖从命令行获取的dbname */
	/* （但*仅*是数据库名称，不是连接字符串中的其他内容） */
	const char *override_dbname;
} ConnParams;

extern PGconn *connectDatabase(const ConnParams *cparams,
							   const char *progname,
							   bool echo, bool fail_ok,
							   bool allow_password_reuse);

extern PGconn *connectMaintenanceDatabase(ConnParams *cparams,
										  const char *progname, bool echo);

extern void disconnectDatabase(PGconn *conn);

#endif							/* CONNECT_UTILS_H */
